contours: validate input raster, reject complex dtype#2711
Merged
brendancol merged 1 commit intoMay 31, 2026
Merged
Conversation
…#2701) contours() skipped the standard _validate_raster() check. A complex-dtype DataArray was silently coerced to float64 (imaginary part dropped, only a ComplexWarning), so contours were traced on the real part instead of being rejected. A non-DataArray input failed late with a confusing dispatch error. Add _validate_raster(agg, func_name='contours', name='agg', ndim=2) at the top of contours(), matching curvature/morphology/sky_view_factor. This drops the now-redundant inline ndim==2 check and adds tests for complex-dtype and non-DataArray inputs.
brendancol
commented
May 29, 2026
Contributor
Author
brendancol
left a comment
brendancol
left a comment
There was a problem hiding this comment.
PR Review: contours: validate input raster, reject complex dtype
Blockers
None.
Suggestions
None.
Nits
test_non_dataarray_rejectedmatches on "xarray.DataArray", which depends on the exact wording of_validate_raster's TypeError message. Fine since both live in this repo, but the test breaks if that message ever changes. Low risk, no action needed.
What looks good
- The fix matches the established pattern: curvature.py, morphology.py, and sky_view_factor.py call
_validate_rasterthe same way. - Validation runs before backend dispatch, so the single check covers all four backends without touching backend code.
- Removing the inline
ndim == 2check is correct._validate_raster(..., ndim=2)raises a ValueError containing "2D", sotest_invalid_ndimstill passes. - Integer-dtype rasters still pass (numeric=True, integer_only=False), so no regression for the existing int input path.
- Both new tests assert the right exception types: ValueError for complex, TypeError for non-DataArray.
Checklist
- Algorithm unchanged (validation-only change)
- All backends covered by the single pre-dispatch check
- NaN handling unchanged
- Edge cases (complex, non-DataArray, 3D, too-small) covered by tests
- No premature materialization
- No benchmark needed (validation guard)
- README unchanged (no API surface change)
- Docstring unchanged; the behavior change is input validation only
Melissari1997
pushed a commit
to Melissari1997/xarray-spatial
that referenced
this pull request
May 31, 2026
…#2701) (xarray-contrib#2711) contours() skipped the standard _validate_raster() check. A complex-dtype DataArray was silently coerced to float64 (imaginary part dropped, only a ComplexWarning), so contours were traced on the real part instead of being rejected. A non-DataArray input failed late with a confusing dispatch error. Add _validate_raster(agg, func_name='contours', name='agg', ndim=2) at the top of contours(), matching curvature/morphology/sky_view_factor. This drops the now-redundant inline ndim==2 check and adds tests for complex-dtype and non-DataArray inputs.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Closes #2701
What
contours()did not validate its input before processing. This adds the standard_validate_raster()check the rest of the codebase uses.ArrayTypeFunctionMappingwithTypeError: Unsupported Array Type. Now raises a clear TypeError up front.The inline
ndim == 2check is removed because_validate_raster(..., ndim=2)covers it with the same "must be 2D" message.Backends
Validation runs before backend dispatch, so the single check covers numpy, cupy, dask+numpy, and dask+cupy. No backend-specific code changed.
Test plan